Document CSI update #12928
Merged
Document CSI update #12928
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
k8s-ci-robot
added
the
cncf-cla: yes
k8s-ci-robot
added
language/en
|
Deploy preview for kubernetes-io-master-staging ready! Built with commit c2fa013 https://deploy-preview-12928--kubernetes-io-master-staging.netlify.com |
msau42
reviewed
Mar 1, 2019
sftim
reviewed
Mar 7, 2019
| @@ -193,6 +194,9 @@ the following types of volumes: | |||
| * Azure Disk | |||
| * Portworx | |||
| * FlexVolumes | |||
| * CSI | |||
|
|
|||
There was a problem hiding this comment.
Can this use a shortcode, ie {{< feature-state for_k8s_version="v1.14" state="alpha" >}}?
There was a problem hiding this comment.
(also, this might want to target dev-1.14 rather than master).
There was a problem hiding this comment.
changed the base to dev-1.14
gnufied
force-pushed
the
add-csi-resize-docs
branch
from
4885b82
to
c2fa013
Compare
|
Deploy preview for kubernetes-io-vnext-staging processing. Building with commit 96000e4 https://app.netlify.com/sites/kubernetes-io-vnext-staging/deploys/5c9006a514aed70008687d29 |
msau42
reviewed
Mar 13, 2019
gnufied
force-pushed
the
add-csi-resize-docs
branch
from
d0e373b
to
e8e2f1d
Compare
k8s-ci-robot
added
size/S
msau42
reviewed
Mar 13, 2019
| {{< feature-state for_k8s_version="v1.14" state="alpha" >}} | ||
|
|
||
| CSI volume expansion requires enabling `ExpandCSIVolumes` feature gate and | ||
| running external resize controller. Please see [external resize controller(https://github.com/kubernetes-csi/external-resizer/)] for more details. |
There was a problem hiding this comment.
oh actually this is more of a detail for the storage driver, not the kubernetes user right? You can try following the pattern of the csi topology docs
There was a problem hiding this comment.
I prefer style used here actually. I am posting screenshot of how both docs look below:
There was a problem hiding this comment.
I have fixed the link render btw.
jimangel
force-pushed
the
dev-1.14
branch
2 times, most recently
from
2534806
to
ead0a28
Compare
k8s-ci-robot
added
the
lgtm
gnufied
force-pushed
the
add-csi-resize-docs
branch
from
e8e2f1d
to
8a3769b
Compare
k8s-ci-robot
removed
the
lgtm
msau42
reviewed
Mar 18, 2019
| {{< feature-state for_k8s_version="v1.14" state="alpha" >}} | ||
|
|
||
| CSI volume expansion requires enabling `ExpandCSIVolumes` feature gate and | ||
| running external resize controller. Please see [external resize controller](https://github.com/kubernetes-csi/external-resizer/) for more details. |
There was a problem hiding this comment.
I still don't think this makes sense for a K8s user. This is an instruction for the CSI driver author that they need to support this sidecar in their deployment. And that's going to be dependent per driver.
There was a problem hiding this comment.
How is this a instruction for CSI driver author? This is just telling k8s admin that they need to run resizer sidecar + enable feature gate if they want CSI resizing to work.
For exmaple - local storage documentation has same detail . Or did you mean by k8s user, not a k8s admin but someone who just uses k8s? I think that distinction is pretty fuzzy in places and I am fine with documenting an alpha feature like this. Because even a non-admin user should know why CSI resizing isn't working for their volume.
There was a problem hiding this comment.
I'm thinking in terms of a K8s end-user assuming that the driver is installed by an admin. Even then, as an admin, they can't just blindly add the sidecar into the spec and expect resizing to work. The driver developers need to update, test and release their driver with resizing support.
There was a problem hiding this comment.
okay sure. I have updated the docs to reflect dependency on respective CSI driver.
gnufied
force-pushed
the
add-csi-resize-docs
branch
from
8a3769b
to
f64d574
Compare
msau42
reviewed
Mar 18, 2019
| {{< feature-state for_k8s_version="v1.14" state="alpha" >}} | ||
|
|
||
| CSI volume expansion requires enabling `ExpandCSIVolumes` feature gate and | ||
| running [external resize controller](https://github.com/kubernetes-csi/external-resizer/). You should also look into specific CSI driver documentation and if it |
There was a problem hiding this comment.
sorry, I really don't think this is an actionable instruction to a K8s user. We don't talk about enabling any of the other CSI sidecars, so I don't think we should call it out here.
Let's point to kubernetes-csi documentation on how a driver developer can add resizing support to their driver. But for an end-user, they should be looking at the CSI driver's documentation on how to enable resizing.
There was a problem hiding this comment.
okay I have removed the bit about having to run sidecar.
gnufied
force-pushed
the
add-csi-resize-docs
branch
from
f64d574
to
c2d3255
Compare
Also fix mistake with ExpandInUsePersistentVolumes documented as beta
gnufied
force-pushed
the
add-csi-resize-docs
branch
from
c2d3255
to
96000e4
Compare
|
/lgtm |
k8s-ci-robot
added
the
lgtm
|
Thanks, everyone! /approve |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: cody-clark The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
k8s-ci-robot
added
the
approved
k8s-ci-robot
pushed a commit
that referenced
this pull request
Mar 25, 2019
* Official documentation on Poseidon/Firmament, a new multi-scheduler support for K8S. (#11752) * Added documentation about Poseidon-Firmament scheduler * Fixed some style issues. * Udpated the document as per the review comments. * Fixed some typos and updated the document * Updated the document as per the review comments. * Document timeout attribute for kms-plugin. (#12158) See 72540. * Official documentation on Poseidon/Firmament, a new multi-scheduler (#12343) * Removed the old version of the Poseidon documentation. Incorrect location. * Official documentation on Poseidon/Firmament, a new multi-scheduler support for K8S (#12069) * Official documentation on Poseidon/Firmament, a new multi-scheduler support for K8S. (#11752) * Added documentation about Poseidon-Firmament scheduler * Fixed some style issues. * Udpated the document as per the review comments. * Fixed some typos and updated the document * Updated the document as per the review comments. * Updated the document as per review comments. Added config details. * Updated the document as per the latest review comments. Fixed nits * Made changes as per latest suggestions. * Some more changes added. * Updated as per suggestions. * Changed the release process section. * SIG Docs edits Small edits to match style guidelines. * add plus to feature state * capitalization * revert feature state shortcode since this is a Kubernetes extension, not a direct feature, it shouldn't use the regular feature state tagging. (cherry picked from commit 7730c15) * Remove initializers from doc. It will be removed in 1.14 (#12331) * kubeadm: Document CRI auto detection functionality (#12462) Signed-off-by: Rostislav M. Georgiev <[email protected]> * Minor doc change for GAing Pod DNS Config (#12514) * Graduate ExpandInUsePersistentVolumes feature to beta (#10574) * Rename 2018-11-07-grpc-load-balancing-with-linkerd.md.md file (#12594) * Add dynamic percentage of node scoring to user docs (#12235) * Add dynamic percentage of node scoring to user docs * addressed review comments * delete special symbol (#12445) * Update documentation for VolumeSubpathEnvExpansion (#11843) * Update documentation for VolumeSubpathEnvExpansion * Address comments - improve descriptions * Graduate Pod Priority and Preemption to GA (#12428) * Added Instana links to the documentation (#12977) * Added link to the Instana Kubernetes integration * Added Instana link for services section Added Instana and a link to the Kubernetes integration to the analytics services section and broadened the scope to APM, monitoring and analytics. * Oxford comma /flex * More Oxford commas, because they matter * Update kubectl plugins to stable (#12847) * documentation for CSI topology beta (#12889) * Document changes to default RBAC discovery ClusterRole(Binding)s (#12888) * Document changes to default RBAC discovery ClusterRole(Binding)s Documentation for kubernetes/enhancements#789 and kubernetes/kubernetes#73807 * documentation review feedback * CSI raw block to beta (#12931) * Change incorrect string raw to block (#12926) Fixes #12925 * Update documentation on node OS/arch labels (#12976) These labels have been promoted to GA: kubernetes/enhancements#793 * local pv GA doc updates (#12915) * Publish CRD OpenAPI Documentation (#12910) * add documentation for CustomResourcePublishOpenAPI * address comments fix links, ordered lists, style and typo * kubeadm: add document for upgrading from 1.13 to 1.14 (single CP and HA) (#13189) * kubeadm: add document for upgrading from 1.13 to 1.14 - remove doc for upgrading 1.10 -> 1.11 * kubeadm: apply amends to upgrade-1.14 doc * kubeadm: apply amends to upgrade-1.14 doc (part2) * kubeadm: apply amends to upgrade-1.14 doc (part3) * kubeadm: add note about "upgrade node experimental-control-plane" + add comment about `upgrade plan` * kubeadm: add missing "You should see output similar to this" * fix bullet indentation (#13214) * mark PodReadinessGate GA (#12800) * Update RuntimeClass documentation for beta (#13043) * Update RuntimeClass documentation for beta * Update feature gate & add upgrade section * formatting fixes * Highlight upgrade action required * Address feedback * CSI ephemeral volume alpha documentation (#10934) * update kubectl documentation (#12867) * update kubectl documentation * add document for Secret/ConfigMap generators * replace `kubectl create -f` by `kubectl apply -f` * Add page for kustomization support in kubectl * fix spelling errors and address comments * Documentation for Windows GMSA feature (#12936) * Documentation for Windows GMSA feature Signed-off-by: Deep Debroy <[email protected]> * Enhancements to GMSA docs Signed-off-by: Deep Debroy <[email protected]> * Fix links Signed-off-by: Deep Debroy <[email protected]> * Fix GMSA link Signed-off-by: Deep Debroy <[email protected]> * Add GMSA feature flag in feature flag list Signed-off-by: Deep Debroy <[email protected]> * Relocate GMSA to container configuration Signed-off-by: Deep Debroy <[email protected]> * Add example for container spec Signed-off-by: Deep Debroy <[email protected]> * Remove changes in Windows index Signed-off-by: Deep Debroy <[email protected]> * Update configure-gmsa.md * Update configure-gmsa.md * Update configure-gmsa.md * Update configure-gmsa.md * Rearrange the steps into two sections and other edits Signed-off-by: Deep Debroy <[email protected]> * Fix links Signed-off-by: Deep Debroy <[email protected]> * Add reference to script to generate GMSA YAMLs Signed-off-by: Deep Debroy <[email protected]> * Some more clarifications for GMSA Signed-off-by: Deep Debroy <[email protected]> * HugePages graduated to GA (#13004) * HugePages graduated to GA * fixing nit for build * Docs for node PID limiting (kubernetes/kubernetes#73651) (#12932) * kubeadm: update the reference documentation for 1.14 (#12911) * kubeadm: update list of generated files for 1.14 NOTE: PLACEHOLDERS! these files are generated by SIG Docs each release, but we need them to pass the k/website PR CI. - add join_phase* (new sub phases of join) - add init_phase_upload-certs.md (new upload certs phase for init) - remove alpha-preflight (now both init and join have this) * kubeadm: update reference docs includes for 1.14 - remove includes from alpha.md - add upload-certs to init-phase.md - add join-phase.md and it's phases * kubeadm: update the editorial content of join and init - cleanup master->control-plane node - add some notes about phases and join - remove table about pre-pulling images - remove outdated info about self-hosting * kubeadm: update target release for v1alpha3 removal 1.14 -> 1.15 * kubeadm: copy edits for 1.14 reference docs (part1) * kubeadm: use "shell" for code blocks * kubeadm: update the 1.14 HA guide (#13191) * kubeadm: update the 1.14 HA guide * kubeadm: try to fix note/caution indent in HA page * kubeadm: fix missing sudo and minor amends in HA doc * kubeadm: apply latest amends to the HA doc for 1.14 * fixed a few missed merge conflicts * Admission Webhook new features doc (#12938) - kubernetes/kubernetes#74998 - kubernetes/kubernetes#74477 - kubernetes/kubernetes#74562 * Clarifications and fixes in GMSA doc (#13226) * Clarifications and fixes in GMSA doc Signed-off-by: Deep Debroy <[email protected]> * Update configure-gmsa.md * Reformat to align headings and pre-reqs better Signed-off-by: Deep Debroy <[email protected]> * Reformat to align headings and pre-reqs better Signed-off-by: Deep Debroy <[email protected]> * Reformat to fix bullets Signed-off-by: Deep Debroy <[email protected]> * Reword application of sample gmsa Signed-off-by: Deep Debroy <[email protected]> * Update configure-gmsa.md * Address feedback to use active voice Signed-off-by: Deep Debroy <[email protected]> * Address feedback to use active voice Signed-off-by: Deep Debroy <[email protected]> * RunAsGroup documentation for Progressing this to Beta (#12297) * start serverside-apply documentation (#13077) * start serverside-apply documentation * add more concept info on server side apply * Update api concepts * Update api-concepts.md * fix style issues * Document CSI update (#12928) * Document CSI update * Finish CSI documentation Also fix mistake with ExpandInUsePersistentVolumes documented as beta * Overall docs for CSI Migration feature (#12935) * Placeholder docs for CSI Migration feature Signed-off-by: Deep Debroy <[email protected]> * Address CR comments and update feature gates Signed-off-by: Deep Debroy <[email protected]> * Add mappings for CSI plugins Signed-off-by: Deep Debroy <[email protected]> * Add sections for AWS and GCE PD migration Signed-off-by: Deep Debroy <[email protected]> * Add docs for Cinder and CSI Migration info Signed-off-by: Deep Debroy <[email protected]> * Clarify scope to volumes with file system Signed-off-by: Deep Debroy <[email protected]> * Change the format of EBS and Cinder CSI Migration sections to follow the GCE template Signed-off-by: Deep Debroy <[email protected]> * Windows documentation updates for 1.14 (#12929) * Updated the note to indicate doc work for 1.14 * first attempt at md export from gdoc * simplifyig * big attempt * moving DRAFT windows content to PR for review * moving content to PR in markdown for review * updated note tags * Delete windows-contributing.md deleting this file as it is already ported to the github contributor guide * fixed formatting in intro and cluster setup guide * updating formatting for running containers guide * rejiggered end of troubleshooting * fixed minor typos * Clarified the windows binary download step * Update _index.md making updates based on feedback * Update _index.md updating ovn-kubernetes docs * Update _index.md * Update _index.md * updating relative docs links updating all the links to be relative links to /docs * Update _index.md * Update _index.md updates for windows services and ovn-kubernetes * formatted for correct step numbering * fix typos * Update _index.md updates for flannel PR in troubleshooting * Update _index.md * Update _index.md updating a few sections like roadmap, services, troubleshooting/filing tickets * Update _index.md * Update _index.md * Update _index.md * Fixed a few whitespace issues * Update _index.md * Update _index.md * Update _index.md * add section on upgrading CoreDNS (#12909) * documentation for kubelet resource metrics endpoint (#12934) * windows docs updates for 1.14 (#13279) * Delete sample-l2bridge-wincni-config.json this file is not used anywhere * Update _index.md * Update _index.md * Update _index.md * Update _index.md * Update _index.md * Rename content/en/docs/getting-started-guides/windows/_index.md to content/en/docs/setup/windows/_index.md moving to new location * Delete flannel-master-kubectl-get-ds.png * Delete flannel-master-kubeclt-get-pods.png * Delete windows-docker-error.png * Add files via upload * Rename _index.md to add-windows-nodes.md * Create _index.md * Update _index.md * Update add-windows-nodes.md * Update add-windows-nodes.md * Create user-guide-windows-nodes.md * Create user-guide-windows-containers.md * Update and rename add-windows-nodes.md to intro-windows-nodes.md * Update user-guide-windows-containers.md * Rename intro-windows-nodes.md to intro-windows-in-kubernetes.md * Update user-guide-windows-nodes.md * Update user-guide-windows-containers.md * Update user-guide-windows-containers.md * Update user-guide-windows-nodes.md * Update user-guide-windows-containers.md * Update _index.md * Update intro-windows-in-kubernetes.md * Update intro-windows-in-kubernetes.md fixing the pause image * Update intro-windows-in-kubernetes.md changing tables from html to MD * Update user-guide-windows-nodes.md converting tables from HTML to MD * Update intro-windows-in-kubernetes.md * Update user-guide-windows-nodes.md * Update user-guide-windows-nodes.md * Update user-guide-windows-nodes.md updating the numbering , even though it messes up the notes a little bit. Jim will file a ticket to follow up * Update user-guide-windows-nodes.md * update to windows docs for 1.14 (#13322) * Update intro-windows-in-kubernetes.md * Update intro-windows-in-kubernetes.md * Update intro-windows-in-kubernetes.md * Update intro-windows-in-kubernetes.md * Update intro-windows-in-kubernetes.md * Update user-guide-windows-containers.md * Update user-guide-windows-nodes.md * Update intro-windows-in-kubernetes.md (#13344) * server side apply followup (#13321) * change some parts of serverside apply docs in response to comments * fix typos and wording * Update config.toml (#13365)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Document CSI volume expansion.
xref kubernetes/enhancements#556